home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 21 / Mac Magazin and MacEasy Magazine CD - Issue 21.iso / Wissenschaft & Technik / yorick12vr1-nofpu folder / include / README < prev    next >
Text File  |  1996-02-13  |  5KB  |  121 lines
  1.  
  2.      The following include files contain Yorick code built from the
  3.      basic Yorick functions.  These are part of the Yorick distribution,
  4.      and are located in the directory Y_SITE/include.
  5.  
  6.    Special functions:
  7.    ------------------
  8.  
  9.    bessel.i   - integer order Bessel functions
  10.      Functions: bessj, bessy, bessi, bessk
  11.    gamma.i    - gamma function and relatives
  12.      Functions: ln_gamma, beta, bico (binomial coefficients), erfc
  13.    series.i   - geometric series solvers
  14.      Functions: series_s (sum a series), series_r (find ratio given
  15.                 sum and number of terms), series_n (find number of
  16.         terms given sum and ratio)
  17.    ellipse.i  - complete elliptic integrals
  18.      Functions: EllipticE, EllipticK
  19.  
  20.    Data fitting and interpolation:
  21.    -------------------------------
  22.  
  23.    fitlsq.i   - least squares fit a piecewise linear function to data
  24.      Function: fitlsq
  25.    fitrat.i   - rational function and polynomial fits
  26.      Functions: fitrat, fitpol
  27.    spline.i   - cubic spline and tensioned spline interpolation
  28.      Functions: spline, tspline
  29.  
  30.    Numerical integration:
  31.    ----------------------
  32.  
  33.    romberg.i  - Romberg and Simpson adaptive integrators
  34.      Functions: romberg, simpson
  35.    rkutta.i   - Runge-Kutta and Bulirsch-Stoer ODE integrators
  36.      Functions: rkutta, rk_integrate, bstoer, bs_integrate, rkdumb
  37.  
  38.    I/O functions:
  39.    --------------
  40.  
  41.    copyb.i    - copy a binary file
  42.      Function: copyb
  43.    netcdf.i   - read and write netcdf binary files
  44.      Functions: nc_open, nc_create, nc_vardef, nc_enddef, nc_addrec
  45.                 (if you only need to read a netcdf file, just use openb
  46.          -- netcdf.i will be included automatically)
  47.    fits.i     - read and write FITS files (IAU astronomical data)
  48.      Functions: fitsRead, fitsWrite, <others>
  49.    prefix.i   - read lists of numbers tagged by a "prefix" at the
  50.                 beginning of each line
  51.      Functions: prefix_find, prefix_read, prefix_write
  52.  
  53.    Graphics:
  54.    ---------
  55.  
  56.    movie.i    - assistance for animation (see demo2.i and demo3.i)
  57.      Functions: movie, movie_stats
  58.    button.i   - implement mouse pushbuttons in a Yorick graphics window
  59.                 (see rezone.i for usage examples)
  60.      Functions: Button, button_plot, button_test, button_build
  61.    plwf.i     - 3-D wire frame plots (painter's algorithm)
  62.      Functions: plwf, plwfset
  63.    pixels.i   - crude attempt to force Yorick to plot cell arrays at
  64.                 one cell per X window pixel
  65.      Functions: pixels, pix_window
  66.    color.i    - palette adjustment, HSV<->RGB transforms
  67.      Functions: brighten, to_hsv, to_rgb, dump_palette
  68.  
  69.    Miscellaneous:
  70.    --------------
  71.  
  72.    mkdoc.i    - extract and alphabetize DOCUMENT comments from include files
  73.      Function: mkdoc
  74.    msort.i    - multiple key sorting functions
  75.      Functions: msort, msort_rank
  76.    roots.i    - Newton-Raphson root and inverse, Brent maxima and minima
  77.      Functions: nraphson, f_inverse, mnbrent, mxbrent
  78.    zroots.i   - find roots of polynomial
  79.      Function: zroot
  80.    gcd.i      - GCD, LCM, prime factorization
  81.      Functions: gcd, lcm, is_prime, factorize
  82.    string.i   - String manipulation, other utilities
  83.      Functions: strtrim, strtolower, getdate, reform, scalar, ...
  84.  
  85.    Demonstration programs:
  86.    -----------------------
  87.  
  88.    demo1.i    - a simple 1-D hydro code
  89.      Functions: demo1, evolve (read the file for more)
  90.    demo2.i    - fancy movies of a drumhead oscillating
  91.                 (solves 2D wave equation on the fly)
  92.      Functions: demo2
  93.    demo3.i    - movie of a chaotic pendulum (way cool)
  94.                 (does Runge-Kutta integration of Lagrangian on the fly)
  95.      Functions: demo3
  96.    demo4.i    - movie of flow around an airfoil
  97.                 (solves for flow field on the fly)
  98.      Functions: demo4
  99.    rezone.i   - point-and-click rezoner for quadrilateral meshes
  100.      Function: rezone, toy_mesh
  101.  
  102.    Test programs:
  103.    --------------
  104.  
  105.    testp.i    - reasonably complete Yorick test suite, except graphics
  106.                 Just include it and the tests run immediately, includes:
  107.      testb.i  - binary file I/O tests
  108.      test1.i  - shock tracker test, poorly vectorizing
  109.      test2.i  - radiation escape factor calculation, highly vectorizing
  110.      test3.i  - scalar arithmetic performance test
  111.    testlp.i   - rough Yorick version of Linpack benchmark
  112.      Function:  testlp
  113.    testg.i    - a few graphics tests (grtest is a crude tutorial)
  114.      Functions: testg, lissajous, grtest
  115.  
  116. Additional functions may be available at your site in the contrib
  117. directory, which is a sibling of this Y_SITE/include directory.  In
  118. Yorick, type:
  119.      Y_SITE
  120. to print the name of the site directory at your site.
  121.